.TH "Zebulon::Underwater::GlobalPoseSensor" 3 "13 Oct 2009" "Version 2" "zebulon" \" -*- nroff -*-
.ad l
.nh
.SH NAME
Zebulon::Underwater::GlobalPoseSensor \- 
.PP
A JAUS Global Pose Sensor for the Robotics Club Underwater Vehicle that supplies roll, pitch, yaw information.  

.SH SYNOPSIS
.br
.PP
.PP
\fC#include <globalposesensor.h>\fP
.PP
Inherits \fBZebulon::CoralAHRS::Interface::Callback\fP.
.SS "Public Member Functions"

.in +1c
.ti -1c
.RI "\fBGlobalPoseSensor\fP ()"
.br
.RI "\fIConstructor. \fP"
.ti -1c
.RI "\fB~GlobalPoseSensor\fP ()"
.br
.RI "\fIDestructor. \fP"
.ti -1c
.RI "virtual int \fBSetupService\fP ()"
.br
.RI "\fIThis method is called to indicate what type of input/output messages and service the component supports. \fP"
.ti -1c
.RI "virtual void \fBProcessMessage\fP (const \fBCoralAHRS::Message\fP *message)"
.br
.RI "\fIThis method converts the callback data from the sensor to Global Pose data and saves it internally. \fP"
.ti -1c
.RI "int \fBInitializeGlobalPoseSensor\fP (const std::string &compassPortName)"
.br
.RI "\fIInitializes the sensors belonging to the global pose object, this does not initialize the JAUS component. \fP"
.ti -1c
.RI "int \fBShutdownGlobalPoseSensor\fP ()"
.br
.RI "\fIShutsdown the Compass interface. \fP"
.ti -1c
.RI "bool \fBIsSensorInitialized\fP () const "
.br
.in -1c
.SS "Protected Attributes"

.in +1c
.ti -1c
.RI "CxUtils::Mutex \fBmSensorMutex\fP"
.br
.RI "\fIMutex for sensor. \fP"
.ti -1c
.RI "\fBCoralAHRS::Interface\fP \fBmCompass\fP"
.br
.RI "\fIDigital compass interface. \fP"
.in -1c
.SH "Detailed Description"
.PP 
A JAUS Global Pose Sensor for the Robotics Club Underwater Vehicle that supplies roll, pitch, yaw information. 
.SH "Member Function Documentation"
.PP 
.SS "int GlobalPoseSensor::InitializeGlobalPoseSensor (const std::string & compassPortName)"
.PP
Initializes the sensors belonging to the global pose object, this does not initialize the JAUS component. \fBParameters:\fP
.RS 4
\fIcompassPortName\fP System name for compass port.
.RE
.PP
\fBReturns:\fP
.RS 4
Jaus::JAUS_OK if sensors initialized, otherwise Jaus::JAUS_FAILURE. 
.RE
.PP

.SS "bool GlobalPoseSensor::IsSensorInitialized () const"\fBReturns:\fP
.RS 4
True if connected to sensors, otherwise false. 
.RE
.PP

.SS "void GlobalPoseSensor::ProcessMessage (const \fBCoralAHRS::Message\fP * message)\fC [virtual]\fP"
.PP
This method converts the callback data from the sensor to Global Pose data and saves it internally. \fBParameters:\fP
.RS 4
\fImessage\fP \fBMessage\fP from CoralAHRS (DataEulerAndSensors). 
.RE
.PP

.PP
Implements \fBZebulon::CoralAHRS::Interface::Callback\fP.
.SS "int GlobalPoseSensor::SetupService ()\fC [virtual]\fP"
.PP
This method is called to indicate what type of input/output messages and service the component supports. \fBReturns:\fP
.RS 4
Jaus::OK; 
.RE
.PP


.SH "Author"
.PP 
Generated automatically by Doxygen for zebulon from the source code.
